home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 4 / CU Amiga Magazine's Super CD-ROM 04 (1996)(EMAP Images)(GB)(Track 1 of 3)[!][issue 1996-11].iso / magazine / psion / misc / vocab.lzx / op_doc.txt next >
Text File  |  2005-01-10  |  6KB  |  164 lines
  1. VOCAB Documentation
  2.  
  3. This software is freebie-ware, but any donations are always appreciated,
  4. and use is at the operators risk (though this is hopefully a safe 
  5. routine !).
  6.  
  7. Please post any observations, suggestions, gripes!
  8.  
  9. I'd be especialy interseted in finding out how to default the menu
  10. to the last option used !.
  11.  
  12.  
  13. OPERATOR NOTES
  14. ==============
  15.  
  16. The aim of this OPL routine is to provide a simple vocablary tester.
  17.  
  18. This fairly simple program has been to fill a possible small gap in the
  19. released Berlitz language module. This routine allows a library of 
  20. foriegn words to be words to be created (for up to six languages ?), and
  21. then to allow for the random testing of these words.
  22.  
  23. Provided in source code OPL format, to allow tweeks for other possible
  24. applications by other potential authors.
  25.  
  26. Data file are created in /OPD/ directory in default drive, under the name
  27. of the languages used. Please ensure this does not conflict with any 
  28. existing files/applications.
  29.  
  30.  
  31. At the moment, the quiz/guessing will only look at one word. For example,
  32. the Spanish word 'manana' means both 'tomorrow' and 'morning', so it
  33. will be a arbitrary choice as to which response the software is after,
  34. although it should be farely obvious after the first guess.
  35.  
  36. The use of '*' to match any number of characters and
  37.            '?' to match any one character
  38. is valid for all entries, other than when supplying a guess!
  39.  
  40.  
  41. As this was put together in a weekend, the code is fairly simple and 
  42. does not do clever things like going to sleep when something else is
  43. 'active'. -Yet.
  44.  
  45.  
  46. MENUS:
  47.  FILE
  48.   N New Language         Allows operator to add a new language
  49.                          to the system
  50.   O Open Language        Specifies which of the available 
  51.                          languages are to be used fo testing
  52.   R Remove Language      Allows operator to remove a language
  53.                          from the system. Note this will delete
  54.                          the data file 
  55.  
  56.  QUIZ
  57.   G Guess Word           Prompts operator to guess at a system given word
  58.   S Specify Search Field Toggle testing of home language and foreign lang 
  59.   F Find word            Finds occurances of words, 
  60.                          uses wild cards and printing 
  61.  
  62.  CHANGE
  63.   U Update word          Edit an existing word entry
  64.   E Enter word           Add a new word to data file
  65.   D Delete word          Remove a word from data file
  66.  
  67.  SPECIAL  
  68.   P Printer Logging      Toggles use of printer if one is attached
  69.   X Exit                 Exits program
  70.  
  71.  
  72. HAVE FUN !
  73.  
  74.  
  75. DEVELOPERS NOTES
  76. ================
  77.  
  78. VARIABLES
  79.  
  80. GLOBALS  - String Arrays
  81. lan$      1..maxnl% names of languages e.g. spanish, german etc
  82. route$    1..10     menu implementation routines
  83.  
  84. GLOBALS  - Strings
  85. cdfn$     1..128    file name of current language data
  86. lfn$      1..128    file name for file containing langauge names 
  87. k$        1..maxnl% menu acivation keys
  88. clan$     1..11     name of current language
  89. spst$     1..25     string on space characters, used for blanking/spacing
  90. sw$       1..20     search word
  91.  
  92.  
  93. GLOBALS  - Integers
  94. lanused%   <=maxnl% number of langaues current in use
  95. clan%      <=maxnl% current language in use
  96. contpr%    boolean  continues printing flag
  97. gupf%      boolean  global update flag, if true-editing, false-insertion
  98. pl%        boolean  used to determine printer logging
  99. prcon%     boolean  printer connected
  100. rcnt%      1..n     no of records in current file    
  101. ssf%       1..2     specifes selection field for FIND option
  102. tgc%       n        total number of guesses
  103. twc%       n        tested word count
  104.  
  105. CONSTANTS
  106. maxnl%    := 6      maximum number of langauges available to system 
  107. true%     := -1     OPL defined boolean value of TRUE
  108. false%    := 0      OPL defined boolean value of FALSE
  109. gend$     1..11     male or female gender option
  110.  
  111.  
  112.  
  113.  
  114. FILE FIELDS
  115. A.lng$              Language name string stored in lfn$ file
  116.  
  117. B.hlw$              Home language word
  118. B.flw$              Foreign language word
  119. B.pho$              Foreign phonetic
  120. B.pog%              Part of grammer
  121. B.bf%               Boolean flags
  122.  
  123.  
  124.  
  125. ROUTINES
  126. Vocab:    Main body      forms closure for executable program
  127. Initial:  Initialisation set initial values for constants, string arrays etc
  128. DrawMenu: Draw Menu      Creates, displays and selects from MENU
  129. DrawScr:  Draw Screen    initial graphic display set up
  130. AddRecs:  \        
  131. AddGues:   \ Screen      Routines for updating main sceen
  132. AddWrds:   / Updates     with statistical info
  133. AddFct:   /
  134. Del:      Delete Word    prompts operator for a string to match against
  135.                          operator further prompted for confirmation
  136.                          before deleting all records with a matching string
  137. Find:     Find Word      prompts the operator for a string to match against
  138.                          displays all matches, quichk option to print all
  139.                          provided, if a printer is attached
  140. Compare$: Compare        Tests one string (as entered by operator) against
  141.                          a second known string. returns a string of located#
  142.                          characters.
  143. Guess:    Guess Word     operator presented with a word and must then
  144.                          enter as guess as to what that word is
  145. Ins:      Insert Word    add a new word to the data file 
  146. New:      New language   add a new language to the system
  147. Open:     Open language  swaps currecnt test language
  148. Upd:      Update word    controls editing of an existing word
  149. Vsn:      Show version   display version of software
  150. Pri:      Print toggle   toggle the print logging
  151. Rmv:      Remove lang    removes a language from the system
  152. SeSpec:   Search toggle  toggles testing on home/country language
  153. ReadLan:  Read languages reads languages from system data file
  154. WritLan:  Write language writes languages back to data file
  155. PrTest:   Printer test   test whether a printer is attached
  156. UseLan:   Use language   specifies which language to use
  157. StMtch:   String Match   test whether the result fron a FIND is valid
  158.                          against the type of seach field currently specified
  159. RunSch:   Run Search     contro;s the FINDing of specified words
  160.  
  161.  
  162.  
  163. Others comments in code
  164.